home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / os2 / tton1970.zip / templeton.cfg < prev    next >
Text File  |  1997-04-11  |  17KB  |  368 lines
  1. # *************************************************************
  2. #  Templeton, copyright 1995, 1996, 1997 N.A. Krawetz
  3. #  All rights reserved.
  4. # *************************************************************
  5.  
  6. # configuration for Templeton
  7. #
  8. # Lines beginning with a '#' are comments and are ignored.
  9. # Lines should not be more than 80 characters.
  10. # Operands in this file are in the form:
  11. #    parameter value
  12. # The parameter is case insensitive, except where a text string or URL
  13. # is required.
  14. # Boolean values ("true" or "false") are case insensitive.
  15. # Numeric values should be numbers -- non-numbers are regarded as 0.
  16. # All other types of values ARE case sensitive.
  17.  
  18.  
  19. # ******************** Registration ****************************
  20. # Register: registration code
  21. # Software that is registered contains a unique registration
  22. # code.  This code should be entered exactly as it is provided.
  23. # If your site contains multiple registrations, you may list
  24. # each registration code on a line starting with the
  25. # key word "Register".
  26. # Please read the licensing agreement for registration
  27. # information.
  28. #   Register 12-34567-891011
  29.  
  30.  
  31. # ******************* File System *****************************
  32. # LocalPath: absolute path
  33. # LocalPath informs the program where to store the downloaded files.
  34. # IF this path is:
  35. #   LocalPath none
  36. # THEN no files are generated.  Only a log file containing the remote
  37. # servers WWW map is created in the current directory.
  38. #
  39. # Currently, files should be stored in the root directory of the file system.
  40. # For WWW servers, this is the server's root directory.
  41. # (This limitation will be removed in future releases.)
  42. # For DOS based machines, this path may include a drive letter:
  43. #   LocalPath e:\server.www\
  44. #
  45. # Either slash "/" or backslash "\" are valid for specifying a directory.
  46. # The trailing slash or backslash is optional.
  47. #
  48. # This option is only used when the "Interactive" option is FALSE.
  49. LocalPath /
  50.  
  51. # FATFormat: boolean
  52. # Determines the file name format for the current operating system.
  53. # DOS based machines using drives formatted with a File Allocation Table (FAT)
  54. # can only handle file names containing 8 characters and a 3 character
  55. # extension.  Setting this option to TRUE will generate 8.3 character file
  56. # names.  The default is FALSE, and will generate unlimited length file names.
  57. # NOTE: Under DOS, this option is always TRUE (DOS only supports FAT file
  58. # names).  Under OS/2, this value becomes TRUE automatically if the destination
  59. # path (LocalPath) is located on a FAT partition.
  60. FATFormat FALSE
  61.  
  62. # User: e-mail address
  63. # In case of emergency, this is the person who is running the program
  64. # and who should be contacted to stop the program from running.
  65. # This MUST be a valid e-mail address, and SHOULD also be available with
  66. # a "talk" command.
  67. # As a side note, it is never a good idea to let automatic software run
  68. # unsupervised (especially this type of software).  The "User" should be
  69. # available to read their e-mail at all times during the execution of this
  70. # program.
  71. # The default is the account running the program on the current machine.
  72. #  User webmaster@host.machine.org
  73.  
  74.  
  75. # ********************* Network *****************************
  76.  
  77. # ProxyHost: hostname or IP address
  78. # Proxy agents are machines that act as a gateway through a firewall.
  79. # If your local network uses a proxy agent, specify the name of
  80. # the proxy agent here.  If you are uncertain about your network, consult your
  81. # network manager or provider.
  82. # A proxy server is only used when a server is specified.
  83. #  ProxyHost    proxyhost.network.net
  84.  
  85. # ProxyPort: integer
  86. # When using a proxy server (see ProxyHost), the port on the proxy server
  87. # should be specified.  The default port is 80.  This value is not
  88. # used if no proxy host is specified with ProxyHost.
  89. ProxyPort    80
  90.  
  91. # Spoof: text-string
  92. # Some WWW servers make incorrect assumptions about the browser/robots.  (Most
  93. # of these are the Netscape servers.)  These servers assume that, since the
  94. # browser is not "Netscape" the browser cannot handle the HTML documents and
  95. # therefore, the document is not transfered.  By "spoofing" a different name,
  96. # the WWW robot can use a qualified browser name to retrieve the HTML
  97. # document.  
  98. # NOTE: The first word of the spoof-name is used for restrictions when 
  99. # robot exclusion is honored (see Exclusion).  This means, if Templeton tells
  100. # the WWW server that it is "Netscape" and the server does not permit
  101. # Netscape browsers, then the server will also not permit Templeton.
  102. # Common spoof names (and browsers) are:
  103. #   Mozilla    Netscape Browser
  104. #   WebCrawler    WebCrawler robot
  105. #   InfoSeek    InfoSeek robot
  106. #   WebExplorer IBM WebExplorer for OS/2
  107. #   Harvest    a web robot
  108. #   Mosaic    NCSA Mosaic
  109. #   Lynx    Lynx, text browser
  110. #   Microsoft Internet Explorer
  111. #   PRODIGY-WB    Prodigy browser
  112. # Spoof Mozilla (Templeton)
  113.  
  114.  
  115. # ********************* Restrictions *****************************
  116.  
  117. # RestrictHost: boolean
  118. # This parameter informs the program not to leave the designated host.  Links
  119. # to machines not on the current host are not traversed.
  120. RestrictHost TRUE
  121.  
  122. # RestrictPath: absolute path
  123. # This parameter is only used when a host is restricted.
  124. # When a host is restricted, a subpath on that host may also be restricted.
  125. # Hypertext references to documents outside this subtree are not traversed.
  126. # Either slash "/" or backslash "\" are valid for specifying a directory.
  127. # The trailing slash or backslash is optional.
  128. RestrictPath /
  129.  
  130. # RestrictDepth: numeric value
  131. # Hyperlinks are travered in a breadth-first search.  An unrestricted search
  132. # may download an entire WWW server's data.  By restricting the depth,
  133. # only immediate portions of the server will be received.
  134. # Images and non-href links are considered to be at the same depth as the
  135. # document.
  136. # A restricted depth of 0 means no restriction.
  137. # The default is 1
  138. RestrictDepth 1
  139.  
  140. # RemoveRestricted: boolean
  141. # This parameter informs the program to remove untraversed links.  Links to
  142. # restricted machines or restricted depths are removed from the HTML file,
  143. # but the visible test is still available (just not a hyperlink).
  144. # The default value is FALSE.
  145. RemoveRestricted FALSE
  146.  
  147. # Add: URL
  148. # Place a specific URL on the list of URLs to process.
  149. # Be aware that restrictions apply.
  150.  
  151. # Exclusion: boolean
  152. # This parameter determines whether Templeton will support server provided
  153. # robot exclusion files (robots.txt).  Many servers maintain exclusion files
  154. # to prevent robots from wandering around virtual directory trees, from
  155. # retrieving very temporary or uncomplete files, or copyright materials.  It
  156. # is considered "polite" for web agents to obey the exclusion files when they
  157. # exist.  The default value, TRUE, means that robot exclusion files are obeyed.
  158. # Setting Exclusion to FALSE will ignore robot exclusion files.
  159. Exclusion TRUE
  160.  
  161. # Deny: URL
  162. # The URL provided, as well as all subtrees or the URL, are not processed.
  163. # Many times specific directory subtrees are not desirable.  You can deny
  164. # retrieval of these URL's using this setting.
  165. # For example, to NOT retrieve the "archive" subtree of the host loco.com,
  166. # you would specify:
  167. #   Deny http://loco.com/archive/
  168. # If you do not include the trailing slash (http://loco.com/archive) then
  169. # all subdirectories beginning with "archive" are not processed.  This
  170. # includes "archive.1", "archive.old", "archive_from_1994", etc.
  171. # Deny statements may also include a '*' as a wild character.  This
  172. # symbol represents 0 or more characters for matching.  If, for example,
  173. # you wish to retrieve all GIF files, you would use:
  174. #   Deny *.gif
  175. # Only one '*' is permitted, but it may be located anywhere in the URL string.
  176. # Multiple Deny statements may be specified.
  177.  
  178. # Allow: URL
  179. # Similar to "Deny", "Allow" explicitly specifies that a subtree is
  180. # retrievable.  When used in conjunction with Deny URL, branches of a
  181. # subtree may be specified for access, while other subtrees are ignored.
  182. # Multiple Allow statements may be specified.
  183.  
  184. # Authorize: "realm" base64-code
  185. # This complex command allows you to specify a username and password
  186. # for basic WWW-authentication.  The realm is a quoted string.
  187. # The base64-code contains the encoded username and password.  Use
  188. # the pwd64.exe program to generate your base64-code.
  189. # The realm is a case-sensitive string provided by the WWW server. If you
  190. # do not know the realm for the pages you wish to retrieve, use Templeton
  191. # to interactively retrieve the page.  Templeton will display the realm
  192. # name and ask for your username and password.
  193. # Be aware that realms are not unique.  If different documents use the
  194. # same realm but require different passwords, Templeton will require
  195. # you to enter the username and password.
  196. # To skip a realm, use the username "-" and password "-", or the
  197. # base64-code: LTot
  198. #  Authorize "Secret Password" ZHIubmVhbDpyZWdpc3RlciBtZQ==
  199.  
  200. # Proxy-Authorize: "realm" base64-code
  201. # Similar to "Authorize", this complex command allows you to specify a
  202. # realm and password for a secure HTTP proxy server.
  203. #  Proxy-Authorize "Secret Password" ZHIubmVhbDpyZWdpc3RlciBtZQ==
  204.  
  205. # Sleep: numeric
  206. # Sleep determines the number of seconds to pause before sending a request to
  207. # a WWW server.  SLEEP IS IMPORTANT.
  208. # Warning: Templeton can generate thousands of requests per minute.  Many 
  209. # WWW servers cannot handle a sudden onslaught of requests.  Setting the
  210. # Sleep parameter to 0 (zero) may generate too many requests for the server
  211. # and kill the server.  This is bad.
  212. # A sleep setting of 0 (zero) is known to kill the following types of servers:
  213. #   All WWW servers that run under Microsoft Windows (TM)
  214. #   Old generation (HTML/1.0) CERN servers on all platforms
  215. # Low sleep values may also generate large amounts of network traffic and
  216. # hog network resources.
  217. # For safety, you should set the sleep interval to at least 5 seconds.
  218. # The longer, the better.  Remember, this program is automated and can
  219. # easily run for hours.  What's the rush?
  220. Sleep 10
  221.  
  222.  
  223. # ********************* Preferences *****************************
  224.  
  225. # FileOverwrite: boolean or "modified"
  226. # Files that already exist on the local system are normally overwritten.
  227. # Setting the FileOverwrite option to FALSE will not overwrite files on the
  228. # local file system.  Setting the FileOverwrite option to "Modified"
  229. # (no quotes) will only retrieve documents (non-HTML) that have been changed
  230. # since the last retrieval.  The modified option is useful when retrieving
  231. # the same URL multiple times; modified will not waste time retrieving GIF
  232. # and JPG files that have already been retrieved.
  233. # FileOverwrite does NOT effect HTML documents -- HTML documents are always
  234. # retrieved.  Templeton can only determine links by retrieving HTML documents.
  235. # Skipping an HTML document would mean skipping possible links.
  236. # Default value is MODIFIED, only retrieving newer non-HTML files.
  237. FileOverwrite modified
  238.  
  239. # Index: file name
  240. # For hypertext references that only specify a directory, this is the
  241. # default html file in the directory.
  242. # NOTE: if FATFormat is TRUE, the 8.3 name translation will be applied to
  243. # this file name.
  244. # The default name is "index.html"
  245. Index index.html
  246.  
  247. # ISMAP: absolute path to executable
  248. # For WWW servers, many imagemaps use a program that takes coordinates from
  249. # a selected image <IMG SRC=... ISMAP> and return a new URL.  Some of the
  250. # more common methods use a data file containing known coordinates and a
  251. # program to identify which URL is activated.  Commonly, this program is
  252. # called "imagemap" or "imagemap.exe".
  253. # The ISMAP parameter specifies the WWW server's path to the imagemap program.
  254. ISMAP /cgi-bin/imagemap
  255.  
  256. # MapType: NCSA or CERN
  257. # For the executable specified in the ISMAP parameter (see above), this
  258. # option determines the format of the file.  If the image map file can be
  259. # retrieved, then it is converted into this specified format.
  260. # Valid options are either "CERN" or "NCSA".  The default is NCSA.
  261. MapType NCSA
  262.  
  263.  
  264. # ********************* Logging *****************************
  265. # Mailto-File: file name
  266. # Similar to "Server-File" logging, the file name listed on the "Mailto-File"
  267. # line contains a list of e-mail addresses found in the HTML documents.  Only
  268. # e-mail addresses that are active (hyperlinks) are used.  E-mail addresses
  269. # displayed as plain text in the document or contained in CGI scripts are not
  270. # listed in the mailto logfile.
  271. # NOTE:  This list MAY contain duplicate entries.  Duplication removal may be
  272. # added in later versions.
  273. # (Some people have found this to be a very useful feature for generating
  274. # mailing lists.)
  275. # The default is no mailto logging.
  276. # Mailto-File mailtolist
  277.  
  278. # RemoteMapping: boolean
  279. # Determines whether remote mapping will be done.  The default is TRUE
  280. # while does perform mapping.  The map file name is mapindex.html and is
  281. # either located at the root of the LocalPath or in the current directory
  282. # if the system is not mirroring files.
  283. # Note: if you change the default index name, for example, to "welcome.html"
  284. # then the default map file will be "mapwelcome.html".
  285. RemoteMapping TRUE
  286.  
  287. # Server-File: file name
  288. # A data file is generated containing the host name, IP address, and
  289. # WWW server type for each server visited.  For servers listed as IP
  290. # address only, the host name is also the IP address.
  291. # The default is no server logging.
  292. # Server-File serverlist
  293.  
  294.  
  295. # ********************* Advanced *****************************
  296. # The advanced configuration commands should be used with caution.
  297. # These commands allow other applications to perform tasks on the
  298. # retrieved documents.  Applications that are spawned (operate
  299. # concurrently) with Templeton may overwhelm the user or operating system.
  300. # Spawned applicatons include those begun with "start" under OS/2,
  301. # or followed by "&" under Unix.
  302. # NOTE: Templeton has the capability to spawn thousands of applications
  303. # in a few seconds.
  304. # On Unix-type systems, Templeton introduces security risks when executed
  305. # as root.
  306. # For applications that are not spawned, Templeton will pause until
  307. # the application has ended.  This allows for a guarenteed order of processing
  308. # for the called applications.
  309.  
  310. # Command_html: string
  311. # Command_image: string
  312. # Command_map: string
  313. # Command_default: string
  314. # Execute a system command on each document stored on the file system.
  315. # The different command types are for HTML documents, images, map files,
  316. # or the default command when any of the other commands are not set.
  317. # This are useful for counting documents, storing statistics, printing,
  318. # converting, etc.
  319. # The string "none" turns off these commands.  This default is "none".
  320. # The command string will replace special characters with desired information:
  321. #  characters:   becomes:
  322. #    %d    depth
  323. #    %h      host (server)
  324. #    %p    remote parent URL (first URL containing a link to this URL)
  325. #    %P    local parent file (first file containing a link to this URL)
  326. #    %l      local file
  327. #    %n    current time in GMT (see %t)
  328. #    %N    current time in local time (see %T)
  329. #    %r      remote file (URL without server)
  330. #    %s      saved file (same as %l)
  331. #    %t    file timestamp (RFC 822 format) in GMT
  332. #    %t{rfc822}    file timestamp in RFC 822 format
  333. #    %t{rfc850}    file timestamp in RFC 850 format
  334. #    %t{ansi-c}    file timestamp in ANSI C format
  335. #    %t{iso8601}    file timestamp in ISO 8601 format
  336. #    %t{iso8601c}    file timestamp in ISO 8601 compressed format
  337. #    %T    similar to %t, but times provided in local time
  338. #    %u      url
  339. #    %%      %
  340. # The special characters ARE case sensitive.
  341. # NOTE: Command_image and Command_default do not distinguish between
  342. #   different file formats.
  343. # Example: to convert all HTML documents to text using the program
  344. # html2txt (not provided with the Templeton distribution), you would use:
  345. #   Command_html html2txt %s
  346.  
  347. # Command_url: string
  348. # Similar to Command_html, this command line string is executed by *every*
  349. # URL found.  This includes other protocols such as "ftp://", "gopher://"
  350. # and "mailto:".  No effort is made toward uniqueness; the same URL may be
  351. # seen hundreds of times.
  352. # Because this command is processed each and every time a URL is found, it may
  353. # significantly slow the runtime performance of Templeton.
  354. # The string "none" turns off this command.  The default is "none".
  355. # This command replaces the same characters as Command_html, except for
  356. # %l and %s; the local file name is unavailable.
  357. # The time formats, %t and %T, show the time the URL was found by Templeton,
  358. # *not* the timestamp of the file.
  359. # The execution of the Command_url string does not effect the execution of
  360. # the Command_html, Command_image, Command_map, or Command_default strings.
  361.  
  362. # Interactive: boolean
  363. # Determines whether the user should be prompted for
  364. # configuration information or if Templeton should
  365. # start running automatically.
  366. # The default setting is TRUE.
  367.  
  368.